<?php

/*
 * (c) Copyright 2009 Hewlett-Packard Development Company, L.P.
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * http://code.google.com/p/gagawa/
 * 
 * AUTHORS:
 *   Mark Kolich
 *   Chris Friedrich
 * 
 */
 
class GagawaUtil {

	/**
	 * Checks if a variable is really "empty".  Code borrowed from PHP.net at
	 * http://us3.php.net/manual/en/function.empty.php#90767 because we were
	 * previously using empty() to see if a variable is empty or not.  But
	 * empty() dosen't work for attributes that have a value of "0", so we need
	 * something more robust here.
	 *
	 *   an unset variable -> empty
	 *   null -> empty
	 *   0 -> NOT empty
	 *   "0" -> NOT empty
	 *   false -> empty
	 *   true -> NOT empty
	 *   'string value' -> NOT empty
	 *   "    " (white space) -> empty
	 *   array() (empty array) -> empty
	 *
	 * There are two optional parameters:
	 *
	 *   allow_false: setting this to true will make the function consider a
	 *   boolean value of false as NOT empty. This parameter is false by default.
	 *
	 *   allow_ws: setting this to true will make the function consider a string
	 *   with nothing but white space as NOT empty. This parameter is false by
	 *   default.
	 */
	public static function gagawaIsEmpty ( $var, $allow_false = false,
											$allow_ws = false ) {
	
	    if ( !isset($var) || is_null($var) ||
	    	 ($allow_ws == false && !is_object($var) && trim($var) == "" && !is_bool($var)) ||
	    	 ($allow_false === false && is_bool($var) && $var === false) ||
	    	 (is_array($var) && empty($var)) ) {   
	        return true;
	    }
	    else {
	        return false;
	    }
	     
 	}
 	
}

?>